home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / qqlink.zip / QQLINK.DOC next >
Text File  |  1993-05-05  |  9KB  |  219 lines
  1.  
  2.  
  3.             ***  QQLink V1.00 - the documentation
  4.  
  5.  
  6.         ---{ 1 }---------{ Introduction }---------
  7.  
  8. Welcome to QQLink - a reply linker for use with the "Squish" mail
  9. processor by Scott J Dudley. If this doesn't make much sense to you,
  10. might have just downloaded the wrong archive - from here on I'll be
  11. assuming that you run, or are about to set up a Fidonet BBS or point
  12. with Scott's software. If some of this is unfamiliar, read Squish.PRN
  13. first, it's got a good basic explanation of what's going on.
  14.  
  15. QQLink is quite a simple programme - if you haven't already, go and set
  16. up the rest of your mail software. Things will tick along quite happily
  17. without it (not that you won't notice the lack!).
  18.  
  19.  
  20.         ---{ 2 }---{ What QQLink does for you }---
  21.  
  22. One of the problems with Fidonet echomail, and similar media such as
  23. Usenet's news is that of threading - jumping forward to a message's
  24. reply/replies, back to its original, between replies to the same
  25. message etc. Unlike a local BBS message area, message numbers, and even
  26. the order of messages may vary, so some tricky method must be used,
  27. first to uniquely identify messages in a way that does not vary from
  28. system to system, and secondly to use this information to encode the
  29. structure of a reply thread into message packets.
  30.  
  31. In Fidonet, this is accomplished by the use of hidden "kludges", called
  32. MSGID and REPLY. This is defined in the standards document "FTS-0009".
  33. Formerly, it was common practice to build the reply links by guessing
  34. from the subject lines of messages - ie. if a message has the subject
  35. "Re: Wibbling and widgets", then the next message with the same subject
  36. becomes its reply.
  37.  
  38. Needless to say, this has some disadvantages, but this is what Squish
  39. will do! For example, often a thread of discussion will split into two
  40. or more subthreads on different topics, but with the same subject line.
  41. Using Squish's builtin reply linking, all the messages in both threads
  42. will become jumbled into one. Also, in situations where a user will not,
  43. or cannot quote others, attempting to find what they were replying to
  44. could become a nightmare.
  45.  
  46. QQLink solves all this, and additionally, usually links faster than
  47. Squish (QQLink stands for Quick sQuish Linker).
  48.  
  49. The speed factor is gained by storing link information in an additional
  50. 8K file for each area linked. This is a very good tradeoff - most
  51. echomail areas take up considerably than this, so an additional 8K is
  52. negligible - Squish takes the same approach to storing its
  53. dupe-database. 
  54.  
  55.  
  56.         ---{ 3 }------{ How you use QQLink }------
  57.  
  58. Simply drop QQLINK.EXE into whatever directory you keep Squish in. You
  59. can test it out by manually linking an area. If your Squish.CFG file is
  60. in the current directory, simply enter
  61.  
  62. QQLink TUB
  63.  
  64. Or QQLink <some area on your system> if you don't receive the TUB echo.
  65. QQLink will automatically read the path to the echo you specify, and its
  66. type (Squish or *.MSG) from your Squish.CFG or AREAS.BBS
  67.  
  68. If you have a Squish configuration file called something other than
  69. Squish.CFG, you can specify it using the -c command line switch (see
  70. below)
  71.  
  72. This manual linking isn't going to be much use if you receive multiple
  73. megabytes a day, however. So the best thing to do is add a call to
  74. QQLink to the batch file you use to process inbound echomail packets.
  75. Make sure Squish is generating an EchoToss.LOG file - the following
  76. should suffice:
  77.  
  78. change  Squish IN OUT
  79. to      Squish IN OUT -fechotoss.LOG
  80.  
  81. if you are using Squish in multipass mode, or doing any other stuff,
  82. consult your Squish.PRN
  83.  
  84. After the call to Squish in your batch file, enter the following:
  85.  
  86. QQLink Squish -fechotoss.LOG
  87. DEL echotoss.LOG
  88.  
  89. If you have other programmes using EchoToss.LOG, make sure they go in
  90. *before* the DEL! QQLink will now run automatically to link any incoming
  91. messages - messages posted by you are assumed to be linked by your BBS
  92. or editor software (this is true for Maximus, and all editors I'm aware
  93. of that use the Squish format).
  94.  
  95. Use of a disk cache with all mail processing software is STRONGLY
  96. recommended.
  97.  
  98.  
  99.         ---{ 4 }---{ Command line parameters }----
  100.  
  101. If you run QQLink with the -? parameter, you will see the following help
  102. screen:
  103.  
  104. Usage: QQLink [-c<Squish.CFG>] [<Areas>] [-k] [-r] [-l] [-f<EchoToss.Log>]
  105.    or: QQLink [-a<Areas.BBS>] [<Areas>] [-k] [-r] [-l] [-f<EchoToss.Log>]
  106.  
  107.     -c, and -a are ways of specifying your areas.
  108.     -f names a file containing a list of area tags to link.
  109.     -r means relink any already linked messages.
  110.     -l means link every area listed in Squish.CFG or Areas.BBS
  111.     -k means delete <EchoToss.log> after linking.
  112.     <Areas> is a list of echo tags of areas you want linked.
  113.  
  114. Example: QQLink -c\Squish\Squish.CFG NETMAIL -fin.log
  115.          This will read \SQUISH\SQUISH.CFG for area definitions, and link
  116.          any new messages in NETMAIL and the areas listed in IN.LOG.
  117.  
  118. I don't have much to add to that, except the following notes.
  119.  
  120. 1) By using the -a switch, you could use QQLink with a *.MSG mail
  121. processor other than Squish, provided that mail processor supported an
  122. Areas.BBS format echo information file.
  123.  
  124. 2) -k has the same effect as a DEL echotoss.LOG command immediately
  125. after the execution of QQLink - any log file specified with the -f
  126. switch will be deleted. This is provided for drop-in compatibility with
  127. SQLink.
  128.  
  129. 3) -r will discard any information gleaned from a .QQL link information
  130. file, and relink and scan the area from scratch. This might be useful if
  131. your .QQL file was corrupted in some way.
  132.  
  133.  
  134.         ---{ 5 }---------{ Why QQLink? }----------
  135.  
  136. At the moment I am aware of two other products that do the same job as
  137. QQLink - Squish itself, and David Nugent's SQLink programme. I've
  138. already discussed the shortcomings of Squish's linker, primarily lack of
  139. support for FTS-0009.
  140.  
  141. I ran SQLink for most of the time since I started my Maximus BBS, until
  142. I developed QQLink to overcome certain problems with SQLink, mainly its
  143. godawful slowness when linking large areas. This is mainly because
  144. SQLink will relink and scan all the messages in an area, as it has no
  145. way of knowing a) where it left off last time, or b) what the MSGIDs of
  146. all those linked messages are.
  147.  
  148. QQLink gets around this by storing this information in a ".QQL" file,
  149. either called <AREA>.QQL for a Squish base, or <AREA>\QQLINK. for a
  150. *.MSG base, where <AREA> is the name of the area. For example, the
  151. Squish area \MAIL\NET would consist of: \MAIL\NET.SQD, \MAIL\NET.SQI,
  152. \MAIL\NET.QQL, and so on.
  153.  
  154. These .QQL files are usually much smaller (8K) than the rest of the
  155. area, so you won't be losing much space. The gain is tremendous - If you
  156. receive 20 new messages in an area where you keep 500, QQLink will link
  157. only the new 50, as opposed to SQLink's working on all 500. In these
  158. circumstances, QQLink would take just 4% of the time SQLink took. For
  159. smaller areas, such as when used on a point, QQLink will still be around
  160. 10 times as fast as SQLink, doing the same job.
  161.  
  162.  
  163.         ---{ 6 }------------{ Cost }--------------
  164.  
  165. Like Squish itself, QQLink is FREEWARE. I retain copyright, but grant
  166. anyone who wishes to the right to use and distribute it, provided:
  167.  
  168.         No charge is levied for copying QQLink above and beyond the
  169.         actual costs of disks or other media, or subscription to a BBS
  170.         from which QQLink is downloaded.
  171.  
  172.         This file, QQLink.DOC, and the accompanying executables are not
  173.         modified in any way, except to place them in a compressed or
  174.         archived format.
  175.  
  176. Of course, QQLink carries no implicit or explicit warranty. I can only
  177. guarantee that it will take up your disk space.
  178.  
  179. If you admire QQLink or use it regularly please send a postcard to the
  180. snailmail address below - I welcome feedback and would like to see how
  181. far around the world QQLink progresses, if it does.
  182.  
  183. If you regularly use QQLink in a commercial environment, add a bar of
  184. chocolate to the postcard. 8-)
  185.  
  186.  
  187.         ---{ 7 }-----{ Reaching the Author }------
  188.  
  189. I can be reached at any of the following addresses:
  190.  
  191. FidoNet:
  192.         Josh Parsons    at 3:771/340.0
  193.         (if you are outside zone 3, it might be best to route netmail
  194.         direct to me or my NC - I've had messages to zone 1 disappear in
  195.         the past)
  196.  
  197. InterNet:
  198.         Josh.Parsons@comp.vuw.ac.nz
  199.  
  200. SnailMail: (ie. post)
  201.  
  202.         Josh Parsons
  203.         42 Glen Rd
  204.         Kelburn
  205.         Wellington 6005
  206.         New Zealand
  207.  
  208.  
  209.         ---{ 9 }-------{ Acknowledgements }-------
  210.  
  211. Thanks to:
  212.         Robert Ruthven for encouraging me.
  213.         Scott J. Dudley for his excellent MSGAPI, which I used.
  214.  
  215. Squish, and Maximus are trademarks of Scott J. Dudley.
  216. Fidonet is a trademark of Tom Jennings.
  217.  
  218.  
  219.